API

System APIs

POST system/domain-values

Creates a new domain value

HTTP method POST
URI https://api.rambase.net/system/domain-values
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 351, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<DomainValue>
2
     <Object
Object

Required/mandatory field

Object/archive/context of the DOV

>{String}</Object>
3
     <Field
Field

Required/mandatory field

Fieldname of the DOV

>{String}</Field>
4
     <Value
Value

Value of the DOV

This field is optional.

>{String}</Value>
5
     <Priority
Priority

Priority of the domainvalue

Minimum value: 0

This field is optional.

>{Integer}</Priority>
6
     <Description
Description

Required/mandatory field

Description of the name/value/code/key

>{String}</Description>
7
     <Repository
Repository

This field is optional.

>
8
          <Scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

This field is optional.

>{String}</Scope>
9
          <LocalMode
LocalMode

Defines rules for local editing

This field is optional.

>{String}</LocalMode>
10
     </Repository>
11
</DomainValue>
1
{
2
     "domainValue": {
3
          "object
Object

Required/mandatory field

Object/archive/context of the DOV

": "{String}",
4
          "field
Field

Required/mandatory field

Fieldname of the DOV

": "{String}",
5
          "value
Value

Value of the DOV

This field is optional.

": "{String}",
6
          "priority
Priority

Priority of the domainvalue

Minimum value: 0

This field is optional.

": "{Integer}",
7
          "description
Description

Required/mandatory field

Description of the name/value/code/key

": "{String}",
8
          "repository
Repository

This field is optional.

": {
9
               "scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

This field is optional.

": "{String}",
10
               "localMode
LocalMode

Defines rules for local editing

This field is optional.

": "{String}"
11
          }
12
     }
13
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<DomainValue>
2
     <DomainValueId
DomainValueId

Identifier of the domain value

>{Integer}</DomainValueId>
3
     <Status
Status

Status of the DOV

>{String}</Status>
4
     <Object
Object

Object/archive/context of the DOV

>{String}</Object>
5
     <Field
Field

Fieldname of the DOV

>{String}</Field>
6
     <Value
Value

Value of the DOV

>{String}</Value>
7
     <Priority
Priority

Priority of the domainvalue

>{Integer}</Priority>
8
     <Description
Description

Description of the name/value/code/key

>{String}</Description>
9
     <TranslatedDescription
TranslatedDescription

Description of the name/value/code/key

>
10
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
11
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>{Integer}</ChangedBy>
12
          <Scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

>{String}</Scope>
13
          <LocalMode
LocalMode

Defines rules for local editing

>{String}</LocalMode>
14
          <OverriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

>{String}</OverriddenStatus>
15
     </TranslatedDescription>
16
</DomainValue>
1
{
2
     "domainValue": {
3
          "domainValueId
DomainValueId

Identifier of the domain value

": "{Integer}",
4
          "status
Status

Status of the DOV

": "{String}",
5
          "object
Object

Object/archive/context of the DOV

": "{String}",
6
          "field
Field

Fieldname of the DOV

": "{String}",
7
          "value
Value

Value of the DOV

": "{String}",
8
          "priority
Priority

Priority of the domainvalue

": "{Integer}",
9
          "description
Description

Description of the name/value/code/key

": "{String}",
10
          "translatedDescription
TranslatedDescription

Description of the name/value/code/key

": {
11
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
12
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": "{Integer}",
13
               "scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

": "{String}",
14
               "localMode
LocalMode

Defines rules for local editing

": "{String}",
15
               "overriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

": "{String}"
16
          }
17
     }
18
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 105991 HTTP 400 Event is not of the same type as event set on the automated flow
Error 100012 HTTP 400 {0} must exist in {1}